Method: of(String, String)

1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.role.ui;
28:
29: import javax.annotation.Nonnull;
30: import it.tidalwave.role.ui.impl.DefaultMutableDisplayable;
31:
32: /***********************************************************************************************************************
33: *
34: * A specialized {@link it.tidalwave.role.ui.LocalizedDisplayable} which is mutable.
35: *
36: * @stereotype Role
37: *
38: * @author Fabrizio Giudici
39: * @it.tidalwave.javadoc.stable
40: *
41: **********************************************************************************************************************/
42: public interface MutableLocalizedDisplayable extends MutableDisplayable, LocalizedDisplayable
43: {
44: public static final Class<MutableLocalizedDisplayable> _MutableLocalizedDisplayable_ =
45: MutableLocalizedDisplayable.class;
46:
47: /*******************************************************************************************************************
48: *
49: * Creates an instance with an initial given display name in {@code Locale.ENGLISH}.
50: *
51: * @param displayName the display name
52: * @return the new instance
53: * @since 3.2-ALPHA-1
54: *
55: ******************************************************************************************************************/
56: @Nonnull
57: public static MutableLocalizedDisplayable of (@Nonnull final String displayName)
58: {
59: return of(displayName, "???");
60: }
61:
62: /*******************************************************************************************************************
63: *
64: * Creates an instance with an initial given display name in {@code Locale.ENGLISH} and an explicit identifier for
65: * {@code toString()}.
66: *
67: * @param displayName the display name
68: * @param toStringName the name to be rendered when {@code toString()} is called
69: * @return the new instance
70: * @since 3.2-ALPHA-1
71: *
72: ******************************************************************************************************************/
73: @Nonnull
74: public static MutableLocalizedDisplayable of (@Nonnull final String displayName,
75: @Nonnull final String toStringName)
76: {
77: return new DefaultMutableDisplayable(displayName, toStringName);
78: }
79: }